<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cryptic Cabinet: CrypticCabinet.Utils.PendingTasksHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="Logo 100x100px.png"/></td>
  <td id="projectalign">
   <div id="projectname">Cryptic Cabinet
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">CrypticCabinet.Utils.PendingTasksHandler Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>An utility class that can execute a sequence of pending actions at a later time. It offers a mechanism to perform an action immediately if it can be executed, or to delay its execution to a future time once it can be executed.  
 <a href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aba27e3226b5d0f49b454b01b849fe7e0" id="r_aba27e3226b5d0f49b454b01b849fe7e0"><td class="memItemLeft" align="right" valign="top">delegate void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#aba27e3226b5d0f49b454b01b849fe7e0">PendingAction</a> ()</td></tr>
<tr class="memdesc:aba27e3226b5d0f49b454b01b849fe7e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines a void pending action that can be executed immediately or as a pending action in the future.  <br /></td></tr>
<tr class="separator:aba27e3226b5d0f49b454b01b849fe7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a020057c5844c40fb97b21e7d57665b56" id="r_a020057c5844c40fb97b21e7d57665b56"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a020057c5844c40fb97b21e7d57665b56">TryExecuteAction</a> (<a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#aba27e3226b5d0f49b454b01b849fe7e0">PendingAction</a> action, bool canExecuteNow)</td></tr>
<tr class="memdesc:a020057c5844c40fb97b21e7d57665b56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to execute the function if canExecuteNow is true, otherwise add it to the queue of pending actions that can then be sequentially executed when ExecutePendingActions() is called.  <br /></td></tr>
<tr class="separator:a020057c5844c40fb97b21e7d57665b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29d11d954a99b722ea4d2ebf1810019e" id="r_a29d11d954a99b722ea4d2ebf1810019e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a29d11d954a99b722ea4d2ebf1810019e">ExecuteAllOrClear</a> (bool canExecuteAll)</td></tr>
<tr class="memdesc:a29d11d954a99b722ea4d2ebf1810019e"><td class="mdescLeft">&#160;</td><td class="mdescRight">If canExecuteAll is true, executes all pending actions sequentially. If canExecuteAll is false, remove all existing pending actions from the list.  <br /></td></tr>
<tr class="separator:a29d11d954a99b722ea4d2ebf1810019e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc57ef5c947455ae21c386561ad9687f" id="r_adc57ef5c947455ae21c386561ad9687f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#adc57ef5c947455ae21c386561ad9687f">ClearActions</a> ()</td></tr>
<tr class="memdesc:adc57ef5c947455ae21c386561ad9687f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears all pending actions, if they are not running at the moment.  <br /></td></tr>
<tr class="separator:adc57ef5c947455ae21c386561ad9687f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d1a08b7cba31f8338d561bb832380cd" id="r_a1d1a08b7cba31f8338d561bb832380cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a1d1a08b7cba31f8338d561bb832380cd">ExecutePendingActions</a> ()</td></tr>
<tr class="memdesc:a1d1a08b7cba31f8338d561bb832380cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sequentially executes all the pending actions.  <br /></td></tr>
<tr class="separator:a1d1a08b7cba31f8338d561bb832380cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An utility class that can execute a sequence of pending actions at a later time. It offers a mechanism to perform an action immediately if it can be executed, or to delay its execution to a future time once it can be executed. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="adc57ef5c947455ae21c386561ad9687f" name="adc57ef5c947455ae21c386561ad9687f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc57ef5c947455ae21c386561ad9687f">&#9670;&#160;</a></span>ClearActions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CrypticCabinet.Utils.PendingTasksHandler.ClearActions </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears all pending actions, if they are not running at the moment. </p>

<p class="reference">Referenced by <a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a29d11d954a99b722ea4d2ebf1810019e">CrypticCabinet.Utils.PendingTasksHandler.ExecuteAllOrClear()</a>, and <a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a1d1a08b7cba31f8338d561bb832380cd">CrypticCabinet.Utils.PendingTasksHandler.ExecutePendingActions()</a>.</p>

</div>
</div>
<a id="a29d11d954a99b722ea4d2ebf1810019e" name="a29d11d954a99b722ea4d2ebf1810019e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29d11d954a99b722ea4d2ebf1810019e">&#9670;&#160;</a></span>ExecuteAllOrClear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CrypticCabinet.Utils.PendingTasksHandler.ExecuteAllOrClear </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>canExecuteAll</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If canExecuteAll is true, executes all pending actions sequentially. If canExecuteAll is false, remove all existing pending actions from the list. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">canExecuteAll</td><td>True to execute all, false to clear all.</td></tr>
  </table>
  </dd>
</dl>

<p class="reference">References <a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#adc57ef5c947455ae21c386561ad9687f">CrypticCabinet.Utils.PendingTasksHandler.ClearActions()</a>, and <a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a1d1a08b7cba31f8338d561bb832380cd">CrypticCabinet.Utils.PendingTasksHandler.ExecutePendingActions()</a>.</p>

</div>
</div>
<a id="a1d1a08b7cba31f8338d561bb832380cd" name="a1d1a08b7cba31f8338d561bb832380cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d1a08b7cba31f8338d561bb832380cd">&#9670;&#160;</a></span>ExecutePendingActions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CrypticCabinet.Utils.PendingTasksHandler.ExecutePendingActions </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sequentially executes all the pending actions. </p>

<p class="reference">References <a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#adc57ef5c947455ae21c386561ad9687f">CrypticCabinet.Utils.PendingTasksHandler.ClearActions()</a>.</p>

<p class="reference">Referenced by <a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#a29d11d954a99b722ea4d2ebf1810019e">CrypticCabinet.Utils.PendingTasksHandler.ExecuteAllOrClear()</a>.</p>

</div>
</div>
<a id="aba27e3226b5d0f49b454b01b849fe7e0" name="aba27e3226b5d0f49b454b01b849fe7e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba27e3226b5d0f49b454b01b849fe7e0">&#9670;&#160;</a></span>PendingAction()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">delegate void CrypticCabinet.Utils.PendingTasksHandler.PendingAction </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Defines a void pending action that can be executed immediately or as a pending action in the future. </p>

</div>
</div>
<a id="a020057c5844c40fb97b21e7d57665b56" name="a020057c5844c40fb97b21e7d57665b56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a020057c5844c40fb97b21e7d57665b56">&#9670;&#160;</a></span>TryExecuteAction()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CrypticCabinet.Utils.PendingTasksHandler.TryExecuteAction </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html#aba27e3226b5d0f49b454b01b849fe7e0">PendingAction</a>&#160;</td>
          <td class="paramname"><em>action</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>canExecuteNow</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Try to execute the function if canExecuteNow is true, otherwise add it to the queue of pending actions that can then be sequentially executed when ExecutePendingActions() is called. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">action</td><td>The action to perform.</td></tr>
    <tr><td class="paramname">canExecuteNow</td><td>True if we can execute the action now, false otherwise.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_pending_tasks_handler_8cs.html">PendingTasksHandler.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_cryptic_cabinet.html">CrypticCabinet</a></li><li class="navelem"><a class="el" href="namespace_cryptic_cabinet_1_1_utils.html">Utils</a></li><li class="navelem"><a class="el" href="class_cryptic_cabinet_1_1_utils_1_1_pending_tasks_handler.html">PendingTasksHandler</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>
